<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.13"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>SSD1306 OLED display driver: ssd1306_interface_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectalign" style="padding-left: 0.5em;">
   <div id="projectname">SSD1306 OLED display driver
   &#160;<span id="projectnumber">1.8.2</span>
   </div>
   <div id="projectbrief">This library is developed to control SSD1306/SSD1331/SSD1351/IL9163/PCD8554 RGB i2c/spi LED displays</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.13 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

</div><!-- top -->
<div class="header">
  <div class="summary">
<a href="#pub-attribs">Public Attributes</a> &#124;
<a href="structssd1306__interface__t-members.html">List of all members</a>  </div>
  <div class="headertitle">
<div class="title">ssd1306_interface_t Struct Reference<div class="ingroups"><a class="el" href="group___l_c_d___h_w___i_n_t_e_r_f_a_c_e___a_p_i.html">I2C/SPI: physical interface functions</a></div></div>  </div>
</div><!--header-->
<div class="contents">

<p><code>#include &lt;<a class="el" href="ssd1306__interface_8h_source.html">ssd1306_interface.h</a>&gt;</code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Public Attributes</h2></td></tr>
<tr class="memitem:afd33289a509ae27cbdafd118b91ff23e"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structssd1306__interface__t.html#afd33289a509ae27cbdafd118b91ff23e">spi</a></td></tr>
<tr class="separator:afd33289a509ae27cbdafd118b91ff23e"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a347dbbf8fdb470d133901c8fbd8c5186"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structssd1306__interface__t.html#a347dbbf8fdb470d133901c8fbd8c5186">start</a> )(void)</td></tr>
<tr class="separator:a347dbbf8fdb470d133901c8fbd8c5186"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1cccdffea7b707f9db54e93375d12a22"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structssd1306__interface__t.html#a1cccdffea7b707f9db54e93375d12a22">stop</a> )(void)</td></tr>
<tr class="separator:a1cccdffea7b707f9db54e93375d12a22"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9d99111dfccc867514cab4e2ae2cd613"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structssd1306__interface__t.html#a9d99111dfccc867514cab4e2ae2cd613">send</a> )(uint8_t data)</td></tr>
<tr class="separator:a9d99111dfccc867514cab4e2ae2cd613"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab753c14b485fd4588cc08ed6bf598b4c"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structssd1306__interface__t.html#ab753c14b485fd4588cc08ed6bf598b4c">send_buffer</a> )(const uint8_t *buffer, uint16_t size)</td></tr>
<tr class="memdesc:ab753c14b485fd4588cc08ed6bf598b4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends bytes to SSD1306 device.  <a href="#ab753c14b485fd4588cc08ed6bf598b4c">More...</a><br /></td></tr>
<tr class="separator:ab753c14b485fd4588cc08ed6bf598b4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a082afeefa07cb717ef3f837667b18491"><td class="memItemLeft" align="right" valign="top">void(*&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structssd1306__interface__t.html#a082afeefa07cb717ef3f837667b18491">close</a> )(void)</td></tr>
<tr class="memdesc:a082afeefa07cb717ef3f837667b18491"><td class="mdescLeft">&#160;</td><td class="mdescRight">deinitializes internal resources, allocated for interface.  <a href="#a082afeefa07cb717ef3f837667b18491">More...</a><br /></td></tr>
<tr class="separator:a082afeefa07cb717ef3f837667b18491"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Describes low level hardware API </p>

<p class="definition">Definition at line <a class="el" href="ssd1306__interface_8h_source.html#l00052">52</a> of file <a class="el" href="ssd1306__interface_8h_source.html">ssd1306_interface.h</a>.</p>
</div><h2 class="groupheader">Member Data Documentation</h2>
<a id="a082afeefa07cb717ef3f837667b18491"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a082afeefa07cb717ef3f837667b18491">&#9670;&nbsp;</a></span>close</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* ssd1306_interface_t::close) (void)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>deinitializes internal resources, allocated for interface. </p>
<p>Deinitializes internal resources, allocated for interface. There is no need to use this function for microcontrollers. In general the function has meaning in Linux-like systems. </p>

<p class="definition">Definition at line <a class="el" href="ssd1306__interface_8h_source.html#l00088">88</a> of file <a class="el" href="ssd1306__interface_8h_source.html">ssd1306_interface.h</a>.</p>

</div>
</div>
<a id="a9d99111dfccc867514cab4e2ae2cd613"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9d99111dfccc867514cab4e2ae2cd613">&#9670;&nbsp;</a></span>send</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* ssd1306_interface_t::send) (uint8_t data)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Sends byte to SSD1306 device </p><dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">data</td><td>- byte to send </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="ssd1306__interface_8h_source.html#l00070">70</a> of file <a class="el" href="ssd1306__interface_8h_source.html">ssd1306_interface.h</a>.</p>

</div>
</div>
<a id="ab753c14b485fd4588cc08ed6bf598b4c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab753c14b485fd4588cc08ed6bf598b4c">&#9670;&nbsp;</a></span>send_buffer</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* ssd1306_interface_t::send_buffer) (const uint8_t *buffer, uint16_t size)</td>
        </tr>
      </table>
</div><div class="memdoc">

<p>Sends bytes to SSD1306 device. </p>
<p>Sends bytes to SSD1306 device. This functions gives ~ 30% performance increase than ssd1306_intf.send.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">buffer</td><td>- bytes to send </td></tr>
    <tr><td class="paramname">size</td><td>- number of bytes to send </td></tr>
  </table>
  </dd>
</dl>

<p class="definition">Definition at line <a class="el" href="ssd1306__interface_8h_source.html#l00080">80</a> of file <a class="el" href="ssd1306__interface_8h_source.html">ssd1306_interface.h</a>.</p>

</div>
</div>
<a id="afd33289a509ae27cbdafd118b91ff23e"></a>
<h2 class="memtitle"><span class="permalink"><a href="#afd33289a509ae27cbdafd118b91ff23e">&#9670;&nbsp;</a></span>spi</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">uint8_t ssd1306_interface_t::spi</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Indicates if spi or i2c interface is used. </p>

<p class="definition">Definition at line <a class="el" href="ssd1306__interface_8h_source.html#l00057">57</a> of file <a class="el" href="ssd1306__interface_8h_source.html">ssd1306_interface.h</a>.</p>

</div>
</div>
<a id="a347dbbf8fdb470d133901c8fbd8c5186"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a347dbbf8fdb470d133901c8fbd8c5186">&#9670;&nbsp;</a></span>start</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* ssd1306_interface_t::start) (void)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Starts communication with SSD1306 display. </p>

<p class="definition">Definition at line <a class="el" href="ssd1306__interface_8h_source.html#l00061">61</a> of file <a class="el" href="ssd1306__interface_8h_source.html">ssd1306_interface.h</a>.</p>

</div>
</div>
<a id="a1cccdffea7b707f9db54e93375d12a22"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a1cccdffea7b707f9db54e93375d12a22">&#9670;&nbsp;</a></span>stop</h2>

<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">void(* ssd1306_interface_t::stop) (void)</td>
        </tr>
      </table>
</div><div class="memdoc">
<p>Ends communication with SSD1306 display. </p>

<p class="definition">Definition at line <a class="el" href="ssd1306__interface_8h_source.html#l00065">65</a> of file <a class="el" href="ssd1306__interface_8h_source.html">ssd1306_interface.h</a>.</p>

</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li>intf/<a class="el" href="ssd1306__interface_8h_source.html">ssd1306_interface.h</a></li>
</ul>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.13
</small></address>
</body>
</html>
